/*
 * File     : CEnumValue.java
 * Created  : 1 May 2011
 *
 * Copyright © 2011 Matthew Wilson (mj. {my-surname} .uk {at} gmail.com)
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
package com.googlecode.dni.type.cenum;

import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * <p>
 *  Annotates a Java enum value with the equivalent C enum's integer value.
 * </p>
 * <p>
 *  As with C, enum values start at zero by default, and increment by one with
 *  each value.  (Java enums have a strict order, defined by their
 *  {@linkplain Enum#ordinal() ordinal}).
 * </p>
 *
 * @see CEnumUnknownValue
 *
 * @author Matthew Wilson
 */
@Retention( RetentionPolicy.RUNTIME )
@Target( ElementType.FIELD )
@Documented
public @interface CEnumValue
{

    /**
     * <p>
     *  The integer value of this enum value.
     * </p>
     * <p>
     *  Subsequent unannotated values will have sequential integer values applied
     *  by default.
     * </p>
     * <p>
     *  If two values are present with the same value (quite legitimate in C),
     *  the first (according to its Java ordinal) will be used as the canonical
     *  value when an enum value is looked up for its integer value.
     * </p>
     *
     * @return the integer value
     */
    int value();

}
